/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 - 2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.projects.csv.bean;

import java.util.List;

/**
 * bean class for describing a folder in csv import mapping.
 */
public interface FolderDescriptor
{

  /**
   * getter for the folderName property.
   * 
   * @return the folderName
   */
  public abstract String getFolderName();



  /**
   * getter for the dependantFolders property.
   * 
   * @return the dependantFolders
   */
  public abstract List<String> getDependantFolders();



  /**
   * getter for the fields property.
   * 
   * @return the fields
   */
  public abstract List<FieldDescriptor> getFields();



  /**
   * returns the {@link EntityDescriptor} associated to the given name.
   * 
   * @param name
   *          the name of the {@link EntityDescriptor} to retrieve
   * @return the {@link EntityDescriptor} associated to the given name
   */
  public abstract EntityDescriptor getEntity(String name);



  /**
   * returns the {@link FieldDescriptor} associated to the given name.
   * 
   * @param name
   *          the name of the {@link FieldDescriptor} to retrieve
   * @return the {@link FieldDescriptor} associated to the given name
   */
  public abstract FieldDescriptor getField(String name);



  /**
   * getter for the entities property.
   * 
   * @return the entities
   */
  public abstract List<EntityDescriptor> getEntities();



  /**
   * getter for the actions property.
   * 
   * @return the actions
   */
  public abstract List<Action> getActions();



  /**
   * getter for the mappingDescriptor property.
   * 
   * @return the mappingDescriptor
   */
  public abstract MappingDescriptor getMappingDescriptor();

}
